Management API

Base Resource URL:

     https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]/[payment-options]

Description:

Provides access to payment options associated with the specified customer.

Available sub-resources:

Resource URL Description
https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]/[payment-options]/[payment-option-id]    Provides access to configuration settings for the specified payment option.

Supported Actions:

create  
Method:  PUT       Implicit:  Yes       Returns:  PaymentOption *      
Consumes:  json, xml  Produces:  json, xml 
 
Creates a payment option.

Parameters:
# Name Type Required Default Description
01 object PaymentOption * Yes Payment option information associated with the merchant.


find  
Method:  GET       Implicit:  Yes       Returns:  PaymentOption[] *      
Consumes:  xurl  Produces:  json, xml 
 
Returns a list of available payment options associated with the specified customer.

Parameters:
# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned to the customer from the search result of a web search.
02 limit Integer No 100 Maximum number of records to load per single search web call made by the customer.